<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template bitmap</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="ODTONE 0.4">
<link rel="up" href="../../odtone_mih_library.html#header..home.carlos.Projectos.odtone.inc.odtone.mih.types.base_hpp" title="Header &lt;/home/carlos/Projectos/odtone/inc/odtone/mih/types/base.hpp&gt;">
<link rel="prev" href="null.html" title="Struct null">
<link rel="next" href="percentage_exception.html" title="Struct percentage_exception">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="'ODTONE - Open Dot Twenty One'" width="100" height="100" src="../.././images/logo.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="null.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../odtone_mih_library.html#header..home.carlos.Projectos.odtone.inc.odtone.mih.types.base_hpp"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="percentage_exception.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="odtone.mih.bitmap"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template bitmap</span></h2>
<p>odtone::mih::bitmap</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../odtone_mih_library.html#header..home.carlos.Projectos.odtone.inc.odtone.mih.types.base_hpp" title="Header &lt;/home/carlos/Projectos/odtone/inc/odtone/mih/types/base.hpp&gt;">/home/carlos/Projectos/odtone/inc/odtone/mih/types/base.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">size_t</span> N<span class="special">,</span> <span class="keyword">typename</span> EnumT<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// <a class="link" href="bitmap.html#odtone.mih.bitmapconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="bitmap.html#idp5945984-bb"><span class="identifier">bitmap</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="bitmap.html#idp5929832-bb">private member functions</a></span>
   <a class="link" href="bitmap.html#idp5930048-bb"><span class="identifier">ODTONE_STATIC_ASSERT</span></a><span class="special">(</span><span class="special">!</span><span class="special">,</span> <span class="string">"N must be a multiple of 8"</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="bitmap.html#idp5931168-bb">public member functions</a></span>
  <span class="keyword">void</span> <a class="link" href="bitmap.html#idp5931384-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="bitmap.html#idp5932096-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="identifier">EnumT</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="bitmap.html#idp5933520-bb"><span class="identifier">set</span></a><span class="special">(</span><span class="identifier">EnumT</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="bitmap.html#idp5934936-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="identifier">EnumT</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="bitmap.html#idp5936360-bb"><span class="identifier">merge</span></a><span class="special">(</span><a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="bitmap.html#idp5938072-bb"><span class="identifier">common</span></a><span class="special">(</span><a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="bitmap.html#idp5939792-bb"><span class="identifier">except</span></a><span class="special">(</span><a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="bitmap.html#idp5941520-bb"><span class="identifier">full</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="bitmap.html#idp5942240-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArchiveT<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="bitmap.html#idp5944088-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">ArchiveT</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp13901160"></a><h2>Description</h2>
<p>BITMAP data type. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>N must be a multiple of 8. </p></td></tr>
</table></div>
<p>
</p>
<div class="refsect2">
<a name="idp13901784"></a><h3>
<a name="odtone.mih.bitmapconstruct-copy-destruct"></a><code class="computeroutput">bitmap</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><a name="idp5945984-bb"></a><span class="identifier">bitmap</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Contruct an empty BITMAP data type. </p>
</li></ol></div>
</div>
<div class="refsect2">
<a name="idp13904984"></a><h3>
<a name="idp5929832-bb"></a><code class="computeroutput">bitmap</code> private member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"> <a name="idp5930048-bb"></a><span class="identifier">ODTONE_STATIC_ASSERT</span><span class="special">(</span><span class="special">!</span><span class="special">,</span> <span class="string">"N must be a multiple of 8"</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
</div>
<div class="refsect2">
<a name="idp13908928"></a><h3>
<a name="idp5931168-bb"></a><code class="computeroutput">bitmap</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5931384-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Clear the BITMAP data type. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5932096-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="identifier">EnumT</span> pos<span class="special">)</span><span class="special">;</span></pre>
<p>Clear the position.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">pos</code></span></p></td>
<td><p>The position on the bitmap to clear. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5933520-bb"></a><span class="identifier">set</span><span class="special">(</span><span class="identifier">EnumT</span> pos<span class="special">)</span><span class="special">;</span></pre>
<p>Set the position.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">pos</code></span></p></td>
<td><p>The position on the bitmap to set. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp5934936-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="identifier">EnumT</span> pos<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the position value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">pos</code></span></p></td>
<td><p>The position on the bitmap to get. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5936360-bb"></a><span class="identifier">merge</span><span class="special">(</span><a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a> b<span class="special">)</span><span class="special">;</span></pre>
<p>Merge the value of the bitmap with another BITMAP data type. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>Both bitmaps must have the same size</p></td></tr>
</table></div>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">b</code></span></p></td>
<td><p>The BITMAP data type to merge with. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5938072-bb"></a><span class="identifier">common</span><span class="special">(</span><a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a> b<span class="special">)</span><span class="special">;</span></pre>
<p>Set the common values between the BITMAP and another BITMAP data type. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>Both bitmaps must have the same size</p></td></tr>
</table></div>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">b</code></span></p></td>
<td><p>The BITMAP data type to compare with. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5939792-bb"></a><span class="identifier">except</span><span class="special">(</span><a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a> b<span class="special">)</span><span class="special">;</span></pre>
<p>Clear the values of the bitmap, if they are set on the given BITMAP. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>Both bitmaps must have the same size</p></td></tr>
</table></div>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">b</code></span></p></td>
<td><p>The BITMAP data type with the values to clear. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp5941520-bb"></a><span class="identifier">full</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Set all poisition of the BITMAP data type. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp5942240-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="bitmap.html" title="Class template bitmap">bitmap</a> <span class="special">&amp;</span> bit<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Check if the two bitmaps are equal. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>Both bitmaps must have the same size</p></td></tr>
</table></div>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">bit</code></span></p></td>
<td><p>The BITMAP data type to compare with. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArchiveT<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp5944088-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">ArchiveT</span> <span class="special">&amp;</span> ar<span class="special">)</span><span class="special">;</span></pre>
<p>Serialize/deserialize the BITMAP data type.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">ar</code></span></p></td>
<td><p>The archive to/from where serialize/deserialize the data type. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2012 Universidade
      Aveiro<br>Copyright &#169; 2009-2012 Instituto
      de Telecomunica&#231;&#245;es - P&#243;lo Aveiro<p>
        This software is distributed under a license. The full license agreement
        can be found in the LICENSE in this distribution. This software may not be
        copied, modified, sold or distributed other than expressed in the named license
        agreement. This software is distributed without any warranty.
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="null.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../odtone_mih_library.html#header..home.carlos.Projectos.odtone.inc.odtone.mih.types.base_hpp"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="percentage_exception.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
